Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / AbstractFolder Class / CopyItemsTo Method / CopyItemsTo(FileSystemEvents,Object,Object,AbstractFolder,Boolean,Boolean,Boolean,Object[]) Method
A object that will be used to raise events. Cannot be .Opaque data that will be passed back to the event handler when an event is raised.if empty subfolders should be included in the copy operation.An array of objects that can be used to filter the items to be copied.


In This Topic
    CopyItemsTo(FileSystemEvents,Object,Object,AbstractFolder,Boolean,Boolean,Boolean,Object[]) Method
    In This Topic
    Copies the folder's items (files and empty folders) to another folder, and raises events during the process.
    Syntax
    'Declaration
     
    
    Protected Overloads Sub CopyItemsTo( _
       ByVal events As FileSystemEvents, _
       ByVal userData As Object, _
       ByVal options As Object, _
       ByVal destinationFolder As AbstractFolder, _
       ByVal recursive As Boolean, _
       ByVal includeFolders As Boolean, _
       ByVal replaceExistingFiles As Boolean, _
       ByVal ParamArray filters() As Object _
    ) 
    'Usage
     
    
    Dim instance As AbstractFolder
    Dim events As FileSystemEvents
    Dim userData As Object
    Dim options As Object
    Dim destinationFolder As AbstractFolder
    Dim recursive As Boolean
    Dim includeFolders As Boolean
    Dim replaceExistingFiles As Boolean
    Dim filters() As Object
     
    instance.CopyItemsTo(events, userData, options, destinationFolder, recursive, includeFolders, replaceExistingFiles, filters)

    Parameters

    events
    A object that will be used to raise events. Cannot be .Opaque data that will be passed back to the event handler when an event is raised.if empty subfolders should be included in the copy operation.An array of objects that can be used to filter the items to be copied.
    userData
    options
    destinationFolder
    recursive
    includeFolders
    replaceExistingFiles
    filters
    Remarks

    If the physical folder specified by destinationFolder does not exist, it is created.

    The difference between CopyItemsTo() and CopyFilesTo() is how empty sub-folders are handled. CopyItemsTo() includes empty sub-folders in the copy operation while CopyFilesTo() only includes files and files found in sub-folders in the copy operation. Unless you specifically want to copy empty folders, it is best to use CopyFilesTo().

    The folder's content (files and subfolders) that matches the provided filters is immediately copied to the destination.

    When replacingExistingFiles is true, any file in the destination that has the same name as a file being copied is automatically replaced.

    When replacingExistingFiles is false, an exception is thrown whenever the destination contains a file with the same name as a file being copied.

    To filter a list of files or folders, you can pass a variable number of objects in the filters parameter. These objects may be of the following types:

    Object type Type of filter applied
    System.String The string is assumed to be a file mask, and a NameFilter object is automatically created for the passed string, with FilterScope.File as the default FilterScope.
    System.IO.FileAttributes A AttributeFilter object is automatically created for the provided attributes, with FilterScope.File as the default FilterScope.
    Filter The provided Filter object is used as-is.
    Array of System.Object Each object in the array may be of the types described in this table, and is used accordingly.
    Other If any other type is found, an exception is thrown.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also